/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *  http://aws.amazon.com/apache2.0
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

package software.amazon.awssdk.regions;

import java.util.Optional;
import software.amazon.awssdk.annotations.SdkPublicApi;

/**
 * The metadata associated with a specific service, in a specific partition.
 *
 * This can be loaded via {@link ServiceMetadata#servicePartitions()}.
 */
@SdkPublicApi
public interface ServicePartitionMetadata {
    /**
     * Retrieve the partition to which this service is known to exist.
     */
    PartitionMetadata partition();

    /**
     * Retrieve the global region associated with this service, in this {@link #partition()}. This will return empty if the
     * service is regionalized in the partition.
     */
    Optional<Region> globalRegion();
}
